vcRobotExecutor

vcRobotExecutor allows you to execute a robot or servo program.

See in: Overview

Module: vcRobotics

Parent: vcBehavior

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
ControllerobjectRWDefines the controller associated with the executor.
CurrentStatementvcStatementRGets the statement currently being executed by the executor.
DigitalInputSignalsvcBooleanSignalMapRWDefines the input signal device associated with the executor.
DigitalOutputSignalsvcBooleanSignalMapRWDefines the output signal device associated with the executor.
IsEnabledBooleanRWDefines if the program is executed during simulation.
IsLoopingBooleanRWDefines if the executor loops its program.
ProgramvcProgramRGets the program associated with the executor.
StatementHandlervcPythonProcessHandlerRWDefines a process handler for controlling the execution of statements in robot program.
See more
See an example of modifying a point-to-point motion statement.

Important: Process statements and Path statements with assigned process handlers are executed by their handlers. That is, those statements are not passed on to the statement handler of executor. Do not call nor try to execute them with the statement handler.
UseExternalExecutorBooleanRWDefines if the component is controlled by external execution mechanism, for example a virtual robot controller.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
callRoutineNoneobject routine,
Optional Keyword[clearCallStack = Boolean]
Executes a routine.

Python execution is not suspended while the routine is being executed.
See more
If suspending is desired then the caller has to implement waiting logic. For example using async-await with `await routine.OnScopeExecuted.wait()`.

An optional clearCallStack argument can be given a False value, thereby the call stack of executor is not cleared before executing routine.
callStatementNonevcStatement routineExecutes a routine.

Python execution is not suspended while the routine is being executed.
See more
If suspending is desired then the caller has to implement waiting logic. For example using async-await with `await routine.OnScopeExecuted.wait()`.

An optional clearCallStack argument can be given a False value, thereby the call stack of executor is not cleared before executing routine.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnPostExecuteStatementNoneTriggered after execution of a statement.
OnPreExecuteStatementNoneTriggered before execution of a statement.
See more
The isImmediate argument defines if the statement will be executed immediately (non time-consuming mode)
OnProgramFinishedNoneTriggered when the execution of program has finished.